
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module fgcp.design</title>
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="fgcp.html"><font color="#ffffff">fgcp</font></a>.design</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="http://code.google.com/p/fgcp-client-api/source/browse/fgcp/design.py">design.py</a></font></td></tr></table>
    <p><tt>VSystem&nbsp;Design&nbsp;for&nbsp;the&nbsp;Fujitsu&nbsp;Global&nbsp;Cloud&nbsp;Platform&nbsp;(FGCP)<br>
&nbsp;<br>
Example:&nbsp;[see&nbsp;tests/test_resource.py&nbsp;for&nbsp;more&nbsp;examples]<br>
&nbsp;<br>
#&nbsp;Connect&nbsp;with&nbsp;your&nbsp;client&nbsp;certificate&nbsp;to&nbsp;region&nbsp;'uk'<br>
from&nbsp;fgcp.resource&nbsp;import&nbsp;FGCPVDataCenter<br>
vdc&nbsp;=&nbsp;FGCPVDataCenter('client.pem',&nbsp;'uk')<br>
&nbsp;<br>
#&nbsp;Get&nbsp;VSystem&nbsp;Design&nbsp;from&nbsp;an&nbsp;existing&nbsp;vsystem&nbsp;or&nbsp;file,&nbsp;and&nbsp;build&nbsp;a&nbsp;new&nbsp;vsystem&nbsp;with&nbsp;it&nbsp;(TODO)<br>
design&nbsp;=&nbsp;vdc.get_vsystem_design('Demo&nbsp;System')<br>
#design.load_file('fgcp_demo_system.txt')<br>
#design.build_vsystem('My&nbsp;New&nbsp;Demo&nbsp;System')<br>
#design.load_vsystem('Demo&nbsp;System')<br>
design.save_file('new_demo_system.txt')</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
    
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="time.html">time</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="fgcp.html#FGCPError">fgcp.FGCPError</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="fgcp.design.html#FGCPDesignError">FGCPDesignError</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="fgcp.resource.html#FGCPResource">fgcp.resource.FGCPResource</a>(<a href="fgcp.resource.html#FGCPElement">fgcp.resource.FGCPElement</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="fgcp.design.html#FGCPDesign">FGCPDesign</a>
</font></dt></dl>
</dd>
</dl>
 <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FGCPDesign">class <strong>FGCPDesign</strong></a>(<a href="fgcp.resource.html#FGCPResource">fgcp.resource.FGCPResource</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>FGCP&nbsp;VSystem&nbsp;Design<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="fgcp.design.html#FGCPDesign">FGCPDesign</a></dd>
<dd><a href="fgcp.resource.html#FGCPResource">fgcp.resource.FGCPResource</a></dd>
<dd><a href="fgcp.resource.html#FGCPElement">fgcp.resource.FGCPElement</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="FGCPDesign-build_vsystem"><strong>build_vsystem</strong></a>(self, vsysName<font color="#909090">=None</font>, filePath<font color="#909090">=None</font>)</dt><dd><tt>Build&nbsp;new&nbsp;VSystem&nbsp;based&nbsp;on&nbsp;loaded&nbsp;VSystem&nbsp;Design</tt></dd></dl>

<dl><dt><a name="FGCPDesign-from_code"><strong>from_code</strong></a>(self, lines)</dt></dl>

<dl><dt><a name="FGCPDesign-from_var"><strong>from_var</strong></a>(self, what, parent<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPDesign-from_yaml"><strong>from_yaml</strong></a>(self, lines)</dt></dl>

<dl><dt><a name="FGCPDesign-load_file"><strong>load_file</strong></a>(self, filePath)</dt><dd><tt>Load&nbsp;VSystem&nbsp;Design&nbsp;from&nbsp;file</tt></dd></dl>

<dl><dt><a name="FGCPDesign-load_vsystem"><strong>load_vsystem</strong></a>(self, vsystem)</dt><dd><tt>Load&nbsp;VSystem&nbsp;Design&nbsp;from&nbsp;vsystem</tt></dd></dl>

<dl><dt><a name="FGCPDesign-save_file"><strong>save_file</strong></a>(self, filePath, format<font color="#909090">='txt'</font>)</dt><dd><tt>Save&nbsp;VSystem&nbsp;Design&nbsp;to&nbsp;file</tt></dd></dl>

<dl><dt><a name="FGCPDesign-to_code"><strong>to_code</strong></a>(self, what)</dt></dl>

<dl><dt><a name="FGCPDesign-to_var"><strong>to_var</strong></a>(self, what)</dt></dl>

<dl><dt><a name="FGCPDesign-to_yaml"><strong>to_yaml</strong></a>(self, what, depth<font color="#909090">=0</font>, suffix<font color="#909090">=''</font>)</dt></dl>

<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>filePath</strong> = None</dl>

<dl><dt><strong>vsysName</strong> = None</dl>

<dl><dt><strong>vsystem</strong> = None</dl>

<hr>
Methods inherited from <a href="fgcp.resource.html#FGCPResource">fgcp.resource.FGCPResource</a>:<br>
<dl><dt><a name="FGCPDesign-__init__"><strong>__init__</strong></a>(self, **kwargs)</dt></dl>

<dl><dt><a name="FGCPDesign-__repr__"><strong>__repr__</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPDesign-check_status"><strong>check_status</strong></a>(self, in_state<font color="#909090">=[]</font>, out_state<font color="#909090">=[]</font>)</dt></dl>

<dl><dt><a name="FGCPDesign-create"><strong>create</strong></a>(self, wait<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPDesign-destroy"><strong>destroy</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPDesign-getid"><strong>getid</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPDesign-getparentid"><strong>getparentid</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPDesign-getproxy"><strong>getproxy</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPDesign-merge_attr"><strong>merge_attr</strong></a>(self, partial)</dt></dl>

<dl><dt><a name="FGCPDesign-retrieve"><strong>retrieve</strong></a>(self, refresh<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPDesign-setparent"><strong>setparent</strong></a>(self, parent)</dt></dl>

<dl><dt><a name="FGCPDesign-show_output"><strong>show_output</strong></a>(self, text<font color="#909090">=''</font>)</dt></dl>

<dl><dt><a name="FGCPDesign-update"><strong>update</strong></a>(self)</dt></dl>

<dl><dt><a name="FGCPDesign-wait_for_status"><strong>wait_for_status</strong></a>(self, in_state<font color="#909090">=[]</font>, out_state<font color="#909090">=[]</font>, timeout<font color="#909090">=900</font>)</dt></dl>

<hr>
Methods inherited from <a href="fgcp.resource.html#FGCPElement">fgcp.resource.FGCPElement</a>:<br>
<dl><dt><a name="FGCPDesign-pformat"><strong>pformat</strong></a>(self, what, depth<font color="#909090">=0</font>)</dt></dl>

<dl><dt><a name="FGCPDesign-pprint"><strong>pprint</strong></a>(self)</dt><dd><tt>Show&nbsp;dump&nbsp;of&nbsp;the&nbsp;FGCP&nbsp;Element&nbsp;for&nbsp;development</tt></dd></dl>

<dl><dt><a name="FGCPDesign-reset_attr"><strong>reset_attr</strong></a>(self, what)</dt></dl>

<hr>
Data descriptors inherited from <a href="fgcp.resource.html#FGCPElement">fgcp.resource.FGCPElement</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FGCPDesignError">class <strong>FGCPDesignError</strong></a>(<a href="fgcp.html#FGCPError">fgcp.FGCPError</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>Exception&nbsp;class&nbsp;for&nbsp;FGCP&nbsp;Design&nbsp;Errors<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="fgcp.design.html#FGCPDesignError">FGCPDesignError</a></dd>
<dd><a href="fgcp.html#FGCPError">fgcp.FGCPError</a></dd>
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="FGCPDesignError-__init__"><strong>__init__</strong></a>(self, status, message, resource<font color="#909090">=None</font>)</dt></dl>

<dl><dt><a name="FGCPDesignError-__str__"><strong>__str__</strong></a>(self)</dt></dl>

<hr>
Data descriptors inherited from <a href="fgcp.html#FGCPError">fgcp.FGCPError</a>:<br>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#FGCPDesignError-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>

<hr>
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><a name="FGCPDesignError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPDesignError-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>

<dl><dt><a name="FGCPDesignError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPDesignError-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>

<dl><dt><a name="FGCPDesignError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPDesignError-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>

<dl><dt><a name="FGCPDesignError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPDesignError-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
&nbsp;<br>
Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>

<dl><dt><a name="FGCPDesignError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>

<dl><dt><a name="FGCPDesignError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPDesignError-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>

<dl><dt><a name="FGCPDesignError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#FGCPDesignError-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>

<dl><dt><a name="FGCPDesignError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>

<dl><dt><a name="FGCPDesignError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>

<hr>
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
</dl>
<dl><dt><strong>args</strong></dt>
</dl>
<dl><dt><strong>message</strong></dt>
</dl>
</td></tr></table></td></tr></table>
</body></html>